docs: synchronize Docusaurus documentation with SDK implementation#185
Closed
cursor[bot] wants to merge 1 commit into
Closed
docs: synchronize Docusaurus documentation with SDK implementation#185cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Calvin Remsburg <cdot65@users.noreply.github.com>
cdot65
approved these changes
Jul 1, 2026
Owner
|
Superseded by #201. This PR had merge conflicts (stale by ~8 days; #187–#200 rewrote several of the same files) and one factual error ( |
cdot65
added a commit
that referenced
this pull request
Jul 9, 2026
…201) - scan-api/architecture: API key HMAC and/or bearer token; lowercase x-pan-token / x-payload-hash headers; init() requires at least one - config/env: fill TOKEN_ENDPOINT defaults + EU regional endpoints - architecture/vocabulary: replace fictional ListingOptions (sort/filters) with real per-service pagination (Mgmt offset/limit, MS/RT skip/limit/ search, DLP page/size); document RequestSpec fields; fill domain vocab - red-team-api: enum casing (COMPLETED/STATIC/FAILED/HIGH/API/ACTIVE), updatePrompt uses `prompt` not `content`, corrected goal_type (AGENT, not the invalid JAILBREAK from the original PR) + status filter - index: zod validation note; MS rule instances vs read-only rules - new Runnable Examples guide page (+ sidebar), including the network-broker example the original PR predated Supersedes #185 (conflicting/stale draft); drops its one bad goal_type example and folds in docs added since.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
init()andApiKeyAuth.updatePromptpayload shape.Validation
npm run docs:build(passed; TypeDoc emitted the existing unresolved-link warning forDashboardAppQuery.appId)npx prettier --check docs-site/docs/developer/architecture.md docs-site/docs/developer/vocabulary.md docs-site/docs/getting-started/configuration.mdx docs-site/docs/getting-started/environment-variables.mdx docs-site/docs/guides/red-team-api.md docs-site/docs/guides/scan-api.md docs-site/docs/index.mdx docs-site/docs/guides/examples.mdx docs-site/sidebars.ts(passed)